home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / Kubuntu 8.10 / kubuntu-8.10-desktop-i386.iso / casper / filesystem.squashfs / usr / share / doc / bluez / control-api.txt < prev    next >
Text File  |  2008-10-04  |  4KB  |  135 lines
  1. BlueZ D-Bus Control API description
  2. ***********************************
  3.  
  4. Copyright (C) 2004-2008  Marcel Holtmann <marcel@holtmann.org>
  5. Copyright (C) 2007-2008  David Stockwell <dstockwell@frequency-one.com>
  6.  
  7.  
  8. Control hierarchy
  9. =================
  10.  
  11. Service        org.bluez
  12. Interface    org.bluez.Control
  13. Object path    [variable prefix]/{hci0,hci1,...}/dev_XX_XX_XX_XX_XX_XX
  14.  
  15. Methods        void Connect()
  16.  
  17.             Connect to remote device (CT or TG).
  18.  
  19.         void Disconnect()
  20.  
  21.             Disconnect remote device.
  22.  
  23.         dict GetProperties()
  24.  
  25.             Returns all properties for the interface. See the
  26.             properties section for available properties.
  27.  
  28.         boolean SendPassthrough(avc_operation_id key, boolean state,
  29.                                 string op_data)
  30.  
  31.             Called to send Passthrough commands. ONLY valid if
  32.             BlueZ device is in CT role.
  33.  
  34.         boolean SendVendorDependent(string op_data)
  35.  
  36.             Called to send VendorDependent commands, other than
  37.             Metadata or Events defined in the AVRCP+Metadata
  38.             specification.
  39.  
  40.         void ChangePlayback(string status, uint32 elapsed)
  41.  
  42.             The status can be "playing", "stopped", "paused",
  43.             "forward-seek", "reverse-seek" or "error". Elapsed is
  44.             the position within the track in milliseconds.
  45.  
  46.         void ChangeTrack(dict metadata)
  47.  
  48.             Called to send the mandated TrackChange event and
  49.             potential metadata information.
  50.  
  51.             Current defined metadata information are represented
  52.             with the following keys:
  53.  
  54.                 Title        string    (mandatory)
  55.                 Artist        string
  56.                 Album        string
  57.                 Genre        string
  58.                 NumberOfTracks    uint32
  59.                 TrackNumber    uint32
  60.                 TrackDuration    uint32    (in milliseconds)
  61.  
  62.         void ChangeSetting(string setting, variant value)
  63.  
  64.             Called to transmit Application Settings, CT Status
  65.             and the like.
  66.  
  67.             Currenet defined settings are represented with the
  68.             following keys:
  69.  
  70.                 Equalizer    off, on
  71.                 Repeat        off, singletrack, alltracks, group
  72.                 Shuffle        off, alltracks, group
  73.                 Scan        off, alltracks, group
  74.                 Battery        normal, warning, critical, external, fullcharge
  75.                 System        powered, unpowered, unplugged
  76.                 Volume        uint8
  77.  
  78. Signals        Connected()
  79.  
  80.             Sent when a successful AVRCP connection has been made
  81.             to the remote device.
  82.  
  83.         Disconnected()
  84.  
  85.             Sent when the AVRCP connection to the remote device
  86.             has been disconnected.
  87.  
  88.         Passthrough(uint8 key, boolean state, int32 company_id,
  89.                                 string op_data)
  90.  
  91.             Called when Passthrough command is received from
  92.             connected device.
  93.  
  94.             NOTE: according to the AV/C Subpanel Spec, company_id
  95.             and op_data are passed ONLY when the key is
  96.             "Vendor_Unique", or 0x7E.
  97.  
  98.             When the key is NOT 0x7E, the signal returns
  99.             company_id=-1, and zero-length op_data.
  100.  
  101.         VendorDependentReceived(string op_data)
  102.  
  103.             Called when VendorDependent message is received from
  104.             connected device (except for Metadata defined in
  105.             Bluetooth SIG AVRCP+Metadata spec).
  106.  
  107.         TrackChanged(dict metadata)
  108.  
  109.             Called when Metadata is received from connected device.
  110.             May be multiple meta attribute/element pairs.
  111.  
  112.         PlaybackChanged(string status, uint32 elapsed)
  113.  
  114.         SettingChanged(string setting, variant value)
  115.  
  116. Properties    uint8 SubUnitID [readonly]
  117.  
  118.             The three-bit Subunit ID from the connected device.
  119.  
  120.         uint8 SubUnitType [readonly]
  121.  
  122.             The five-bit Subunit Type from the connected device.
  123.  
  124.         boolean Connected [readonly]
  125.  
  126.         array{uint32} CompanyIDs [readonly]
  127.  
  128.             List of three-byte Company IDs (OUI) supported by the
  129.             connected device. Note that Bluetooth SIG Company
  130.             ID (0x001958) is always included.
  131.  
  132.         array{string} Capabilities [readonly]
  133.  
  134.             List of Capabilities provided by the connected device.
  135.